home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / tcl / tcl70b2.lha / tcl7.0b2 / doc / catch.n < prev    next >
Text File  |  1993-04-14  |  2KB  |  51 lines
  1. '\"
  2. '\" Copyright (c) 1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/catch.n,v 1.1 93/04/14 16:52:57 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .so man.macros
  24. .HS catch tcl
  25. .BS
  26. '\" Note:  do not modify the .SH NAME line immediately below!
  27. .SH NAME
  28. catch \- Evaluate script and trap exceptional returns
  29. .SH SYNOPSIS
  30. \fBcatch\fI script \fR?\fIvarName\fR?
  31. .BE
  32.  
  33. .SH DESCRIPTION
  34. .PP
  35. The \fBcatch\fR command may be used to prevent errors from aborting
  36. command interpretation.  \fBCatch\fR calls the Tcl interpreter recursively
  37. to execute \fIscript\fR, and always returns a TCL_OK code, regardless of
  38. any errors that might occur while executing \fIscript\fR.  The return
  39. value from \fBcatch\fR is a decimal string giving the
  40. code returned by the Tcl interpreter after executing \fIscript\fR.
  41. This will be \fB0\fR (TCL_OK) if there were no errors in \fIscript\fR;
  42. otherwise
  43. it will have a non-zero value corresponding to one of the exceptional
  44. return codes (see tcl.h for the definitions of code values).  If the
  45. \fIvarName\fR argument is given, then it gives the name of a variable;
  46. \fBcatch\fR will set the variable to the string returned
  47. from \fIscript\fR (either a result or an error message).
  48.  
  49. .SH KEYWORDS
  50. catch, error
  51.